Generating an API Key

Generating an API Key

An API key must be generated before the API can be used. Each key is specific to a project, and can not be used for other projects. The API key will be part of the URL used to call the API.



Creating an API Key

1. Enter the project you'd like to create the key for, and login as an administrator user.
2. Go to Tools > Project > Project Settings.
3. In the API Key field, click the the Create button.
4. The API key value will appear.
5. Click Save. 

Deleting an API Key

1. Enter the project you'd like to delete the key from, and login as an administrator user.
2. Go to Tools > Project > Project Settings.
3. In the API Key field, click the trash icon next to the key.
4. Click Save.
5. If needed, you can then generate a new key. 
Note - Deleting the API key will break any functionality currently using that key.

© Copyright 2024 WorkplaceManagement - All Rights Reserved

The page was designed with Mobirise